StoneX API

The StoneX Application Programming Interface is a representational state transfer (REST) web services API. It enables connecting your own front-end trading solution to our back-end.

The trading solution can be a client side desktop user interface (UI), or mobile and tablet trading Apps. Your custom trading solution can also be algorithmic trading strategies that you want to auto-trade. Whatever your trading solution, the StoneX API enables you to connect and trade in a way that meets your needs and suits the way you trade.

Range of Functionality

The API supports trading with the full functionality available on any of the trading platforms provided to your account. All of the markets that your account is able to trade can be accessed and traded through the StoneX API.

For example, your desktop UI or App can perform the following transactions through the StoneX API:

Account login and viewing of account information such as current balance and margin.
Display streaming market prices and market information.
Place trades and enter all supported order types such as protective stop loss and take profit limits.
View your current open positions and historical trades.
View your current active orders and historical order activity.
Retrieve historical market data for charting purposes.
Access and read the latest market and financial news stories.

Programming Language Compatibility

The API is compatible with any programming language that can communicate hypertext transport protocol (HTTP) web service commands, and parse JavaScript object notation (JSON). For example, the C family of programming languages (C, C++ and C#), JavaScript, Java, and Python.

Real time data streams are exposed using the third party Lightstreamer protocol, and require the use of the latest Lightstreamer client library. Documentation, information and Lightstreamer client libraries can be accessed and downloaded from the Lightstreamer website here.

StoneX API Documentation

The non-streaming part of the StoneX API is completely documented via the online package you are currently reading. There is a separate glossary with explanations for commonly used trading and StoneX API terminology. Access this from the tab showing a book icon in the left side pane. An index of all parameters used in service calls can be accessed from the Index tab located in the left side pane.

The streaming part of the StoneX API is based on the third party product Lightstreamer. Documentation for Lightstreamer is accessed from the Lightstreamer website here.

The StoneX API documentation is divided into the following parts.

Getting Started

This introduces you to the StoneX API describing the API architecture, API basics, and interaction process. It provides sequence diagrams showing the work flow for various trading operations, illustrates the order life cycle, some UML class diagrams, and a section of notes on using the API.

It is suggested you work through all topics in this section consecutively before you start coding.

How Do I...?

A section providing examples and explanatory notes on the calls and procedure to perform common trading actions. For example: how to check the margin requirements before placing a trade, how to find a market ID, how to place a trade, how to place an entry order, or how to modify stops/limits attached to an open trade.

StoneX API Reference Section

This provides the specifications for all API methods and data types.

Last updated: 23 July 2024